Favicon

You are here: Home > API Reference > App Distribution > Integration Builds > Update build

Update build

Update build

PUT
https://api.applivery.io/v1/integrations/builds/{buildId} 
curl -X PUT "https://api.applivery.io/v1/integrations/builds/{buildId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "versionName": "string",
  "tags": [
    "string"
  ],
  "changelog": "string"
}'
const response = await fetch("https://api.applivery.io/v1/integrations/builds/{buildId}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "versionName": "string",
    "tags": [
      "string"
    ],
    "changelog": "string"
  }),
});

const data = await response.json();
import requests

response = requests.put(
    "https://api.applivery.io/v1/integrations/builds/{buildId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "versionName": "string",
      "tags": [
        "string"
      ],
      "changelog": "string"
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

buildId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json
versionName string optional
≤ 256 characters
tags array [string] optional
changelog string optional 
{
    "versionName": "string",
    "tags": [
        "string"
    ],
    "changelog": "string"
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
status string optional
pending in_progress waiting_to_be_processed processed error
tags array [string] optional
versionName string optional
≤ 1000 characters
organizationInfo object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
slug string optional
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$
store object optional
branding object optional
configuration object optional
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
application string optional
Match pattern: ^[a-fA-F0-9]{24}$
applicationInfo object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
slug string optional
≤ 256 characters
picture string optional
changelog string optional
originalFile object optional
originalName string optional
≤ 256 characters
mimetype string optional
≤ 128 characters
size integer optional
≥ 0
bucket string optional
≤ 256 characters
key string optional
≤ 256 characters
location string optional
≤ 256 characters
region string optional
≤ 128 characters
storageProviderId string optional
Match pattern: ^[a-fA-F0-9]{24}$
checksum string optional
≤ 256 characters
info object optional
icon string optional
≤ 256 characters
ios object optional
android object optional
pkg object optional
app object optional
msi object optional
exe object optional
msixbundle object optional
appxbundle object optional
msix object optional
appx object optional
scripts object optional
package object optional
extraFiles array [object] optional
target string optional
≤ 256 characters
file object optional
buildProcessor object optional
provider string optional
≤ 256 characters
runName string optional
≤ 256 characters
runId string optional
≤ 256 characters
size integer optional
≥ 0
processTime integer optional
≥ 0
queuedTime integer optional
≥ 0
versionCode string optional
≤ 128 characters
error string optional
errorCode string optional
≤ 128 characters
os string optional
ios android aosp macos windows package
buildPlatform string optional
≤ 128 characters
deployer object optional
name string optional
≤ 256 characters
info object optional
uploadedBy object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
≤ 256 characters · Format: email
firstName string optional
≤ 128 characters
lastName string optional
≤ 128 characters
picture string optional
originalExtension string optional
≤ 128 characters
extension string optional
≤ 128 characters
storageProvider object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
region string optional
≤ 128 characters
config string optional
≤ 128 characters
provider string optional
≤ 128 characters
processLogs array [object] optional
dateMs integer optional
≥ 0
message string optional
metadata object optional
externalFileUrl string optional
≤ 500 characters
hasEmmJson boolean optional
defaultScripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
files array [object] optional
id string optional
≤ 128 characters
type string optional
aab attachment original package icon
description string optional
≤ 256 characters
file object optional
metadata object optional
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
disabled boolean optional 
{
    "status": true,
    "data": {
        "id": "string",
        "status": "pending",
        "tags": [
            "string"
        ],
        "versionName": "string",
        "organizationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "store": {
                "customDomain": "string"
            },
            "branding": {
                "logo": "string",
                "picture": "string",
                "primaryColor": "string"
            },
            "configuration": {
                "storageProvider": "string"
            },
            "createdBy": "string"
        },
        "application": "string",
        "applicationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "picture": "string"
        },
        "changelog": "string",
        "originalFile": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string"
        },
        "info": {
            "icon": "string",
            "ios": {
                "plist": {
                    "CFBundleName": "string",
                    "CFBundleDisplayName": "string",
                    "CFBundleVersion": "string",
                    "CFBundleShortVersionString": "string",
                    "CFBundleIdentifier": "string",
                    "CFBundleSupportedPlatforms": [
                        "string"
                    ],
                    "MinimumOSVersion": "string",
                    "CFBundleIcons": [
                        "string"
                    ],
                    "UIDeviceFamily": [
                        "string"
                    ]
                },
                "mobileprovision": {
                    "TeamName": "string",
                    "ProvisionsAllDevices": true,
                    "ProvisionedDevices": "string",
                    "TeamIdentifier": "string",
                    "ExpirationDate": "2024-01-01T00: 00:00Z",
                    "GetTaskAllow": true,
                    "BetaReportsActive": true,
                    "Name": "string",
                    "signingType": "appStore"
                }
            },
            "android": {
                "versionCode": "string",
                "versionName": "string",
                "platformBuildVersionCode": "string",
                "platformBuildVersionName": "string",
                "packageName": "string",
                "minSDKVersion": "string",
                "targetSdkVersion": "string",
                "icon": "string",
                "productName": "string"
            },
            "pkg": {
                "CFBundleName": "string",
                "CFBundleDisplayName": "string",
                "CFBundleVersion": "string",
                "CFBundleShortVersionString": "string",
                "CFBundleIdentifier": "string",
                "CFBundleSupportedPlatforms": [
                    "string"
                ],
                "MinimumOSVersion": "string",
                "relatedPkgs": [
                    {
                        "distribution": {
                            "id": "string",
                            "active": "string",
                            "auth": "string",
                            "installKBytes": "string",
                            "onConclusion": "string",
                            "onConclusionScript": "string",
                            "version": "string",
                            "archiveKBytes": "string",
                            "packageIdentifier": "string",
                            "text": "string"
                        },
                        "plistInfo": {
                            "CFBundleName": "string",
                            "CFBundleDisplayName": "string",
                            "CFBundleVersion": "string",
                            "CFBundleShortVersionString": "string",
                            "CFBundleIdentifier": "string",
                            "CFBundleSupportedPlatforms": [
                                [
                                    "string"
                                ]
                            ],
                            "MinimumOSVersion": "string"
                        },
                        "iconFile": "string"
                    }
                ]
            },
            "app": {
                "CFBundleName": "string",
                "CFBundleDisplayName": "string",
                "CFBundleVersion": "string",
                "CFBundleShortVersionString": "string",
                "CFBundleIdentifier": "string",
                "CFBundleSupportedPlatforms": [
                    [
                        "string"
                    ]
                ],
                "CFBundlePackageType": "string",
                "LSMinimumSystemVersion": "string"
            },
            "msi": {
                "productCode": "string",
                "productVersion": "string",
                "productName": "string",
                "manufacturer": "string"
            },
            "exe": {
                "fileSize": "string",
                "fileVersionNumber": "string",
                "fileOS": "string",
                "fileDescription": "string",
                "fileVersion": "string",
                "originalFileName": "string",
                "productName": "string",
                "productVersion": "string",
                "companyName": "string"
            },
            "msixbundle": {
                "applicationsData": [
                    {
                        "arch": "string",
                        "fileName": "string",
                        "size": "string",
                        "version": "string"
                    }
                ],
                "packageName": "string",
                "version": "string"
            },
            "appxbundle": {
                "applicationsData": [
                    {
                        "arch": "string",
                        "fileName": "string",
                        "size": "string",
                        "version": "string"
                    }
                ],
                "packageName": "string",
                "version": "string"
            },
            "msix": {
                "displayName": "string",
                "publisherDisplayName": "string",
                "version": "string",
                "arch": "string",
                "name": "string"
            },
            "appx": {
                "displayName": "string",
                "publisherDisplayName": "string",
                "version": "string",
                "arch": "string",
                "name": "string"
            },
            "scripts": {
                "preInstall": "string",
                "postInstall": "string"
            },
            "package": {
                "name": "string",
                "version": "string"
            }
        },
        "extraFiles": [
            {
                "target": "string",
                "file": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string"
                }
            }
        ],
        "buildProcessor": {
            "provider": "string",
            "runName": "string",
            "runId": "string"
        },
        "size": 0,
        "processTime": 0,
        "queuedTime": 0,
        "versionCode": "string",
        "error": "string",
        "errorCode": "string",
        "os": "ios",
        "buildPlatform": "string",
        "deployer": {
            "name": "string",
            "info": {
                "commitMessage": "string",
                "commit": "string",
                "branch": "string",
                "triggerTimestamp": "string",
                "buildUrl": "string",
                "ciUrl": "string",
                "repositoryUrl": "string",
                "buildNumber": "string",
                "tag": "string"
            }
        },
        "uploadedBy": {
            "id": "string",
            "email": "[email protected]",
            "firstName": "string",
            "lastName": "string",
            "picture": "string"
        },
        "originalExtension": "string",
        "extension": "string",
        "storageProvider": {
            "id": "string",
            "name": "string",
            "region": "string",
            "config": "string",
            "provider": "string"
        },
        "processLogs": [
            {
                "dateMs": 0,
                "message": "string"
            }
        ],
        "metadata": {},
        "externalFileUrl": "string",
        "hasEmmJson": true,
        "defaultScripts": {
            "preInstall": "string",
            "postInstall": "string",
            "audit": "string",
            "enforce": "string",
            "runner": "string"
        },
        "files": [
            {
                "id": "string",
                "type": "aab",
                "description": "string",
                "file": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string"
                },
                "metadata": {},
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "disabled": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}